home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / csrot.z / csrot
Encoding:
Text File  |  2002-10-03  |  12.1 KB  |  265 lines

  1.  
  2.  
  3.  
  4. CCCCSSSSRRRROOOOTTTT((((3333SSSS))))                                                            CCCCSSSSRRRROOOOTTTT((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CCCCSSSSRRRROOOOTTTT, ZZZZDDDDRRRROOOOTTTT - Applies a real plane rotation to a pair of complex vectors
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      Single precision complex
  13.  
  14.           Fortran:
  15.                CCCCAAAALLLLLLLL CCCCSSSSRRRROOOOTTTT ((((_n,,,, _x,,,, _i_n_c_x,,,, _y,,,, _i_n_c_y,,,, _c,,,, _s))))
  16.  
  17.           C/C++:
  18.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  19.                vvvvooooiiiidddd ccccssssrrrrooootttt ((((iiiinnnntttt _n,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_y,,,,
  20.                iiiinnnntttt _i_n_c_y,,,, ffffllllooooaaaatttt _c,,,, ffffllllooooaaaatttt _s))));;;;
  21.  
  22.           C++ STL:
  23.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  24.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  25.                vvvvooooiiiidddd ccccssssrrrrooootttt ((((iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _i_n_c_x,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  26.                *_y,,,, iiiinnnntttt _i_n_c_y,,,, ffffllllooooaaaatttt _c,,,, ffffllllooooaaaatttt _s))));;;;
  27.  
  28.      Double precision complex
  29.  
  30.           Fortran:
  31.                CCCCAAAALLLLLLLL ZZZZDDDDRRRROOOOTTTT ((((_n,,,, _x,,,, _i_n_c_x,,,, _y,,,, _i_n_c_y,,,, _c,,,, _s))))
  32.  
  33.           C/C++:
  34.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  35.                vvvvooooiiiidddd zzzzddddrrrrooootttt ((((iiiinnnntttt _n,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_y,,,,
  36.                iiiinnnntttt _i_n_c_y,,,, ddddoooouuuubbbblllleeee _c,,,, ddddoooouuuubbbblllleeee _s))));;;;
  37.  
  38.           C++ STL:
  39.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  40.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  41.                vvvvooooiiiidddd zzzzddddrrrrooootttt ((((iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_x,,,, iiiinnnntttt _i_n_c_x,,,,
  42.                ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_y,,,, iiiinnnntttt _i_n_c_y,,,, ddddoooouuuubbbblllleeee _c,,,, ddddoooouuuubbbblllleeee _s))));;;;
  43.  
  44. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  45.      These routines are part of the SCSL Scientific Library and can be loaded
  46.      using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
  47.      directs the linker to use the multi-processor version of the library.
  48.  
  49.      When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
  50.      4 bytes (32 bits). Another version of SCSL is available in which integers
  51.      are 8 bytes (64 bits).  This version allows the user access to larger
  52.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  53.      by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
  54.      only one of the two versions; 4-byte integer and 8-byte integer library
  55.      calls cannot be mixed.
  56.  
  57.      The C and C++ prototypes shown above are appropriate for the 4-byte
  58.      integer version of SCSL. When using the 8-byte integer version, the
  59.      variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCSSSSRRRROOOOTTTT((((3333SSSS))))                                                            CCCCSSSSRRRROOOOTTTT((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      file should be included.
  75.  
  76. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  77.      These routines apply a real plane rotation to a pair of complex vectors.
  78.      The form of the operation is the following:
  79.  
  80.           _    _    _       _  _    _
  81.           | x  |    | c   s |  | x  |
  82.           |  i |    |       |  |  i |
  83.           |    |    |       |  |    |
  84.           | y  |:=  | -s  c |  | y  |
  85.           |  i |    |       |  |  i |
  86.           -    -    -       -  -    -
  87.  
  88.  
  89.      for each pair of values (_x(_i), _y(_i)), _i=1,..., _n
  90.  
  91.      See the NOTES section of this man page for information about the
  92.      interpretation of the data types described in the following arguments.
  93.  
  94.      This routine has the following arguments:
  95.  
  96.      _n         Integer.  (input)
  97.                Number of pairs of elements of _x and _y to be rotated.
  98.  
  99.      _x         Array of dimension (_n-1) * |_i_n_c_x| + 1.  (input and output)
  100.                CCCCSSSSRRRROOOOTTTT: Single precision complex array.
  101.                ZZZZDDDDRRRROOOOTTTT: Double precision complex array.
  102.  
  103.                On input, array _x.  If _i_n_c_x > 0, _x(_i) is stored in _x(1+(_i-1) *
  104.                _i_n_c_x); if _i_n_c_x < 0, _x(_i) is stored in _x(1-(_n-_i) * _i_n_c_x).  On
  105.                output, the rotated vector _x.
  106.  
  107.      _i_n_c_x      Integer.  (input)
  108.                Increment between elements of _x.  _i_n_c_x should not be 0.
  109.  
  110.      _y         Array of dimension 1+(_n-1) * |_i_n_c_y|). (input and output)
  111.                CCCCSSSSRRRROOOOTTTT: Single precision complex array.
  112.                ZZZZDDDDRRRROOOOTTTT: Double precision complex array.
  113.  
  114.                On input, array _y.  If _i_n_c_y > 0, _y(_i) is stored in _y(1+(_i-1) *
  115.                _i_n_c_y); if _i_n_c_y < 0, _y(_i) is stored in _y(1-(_n-_i) * _i_n_c_y).  On
  116.                output, the rotated vector _y.
  117.  
  118.      _i_n_c_y      Integer.  (input)
  119.                Increment between elements of _y.  _i_n_c_y should not be 0.
  120.  
  121.      _c         Cosine of the angle of rotation. (input)
  122.                CCCCSSSSRRRROOOOTTTT: Single precision.
  123.                ZZZZDDDDRRRROOOOTTTT: Double precision.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCSSSSRRRROOOOTTTT((((3333SSSS))))                                                            CCCCSSSSRRRROOOOTTTT((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      _s         Sine of the angle of rotation. (input)
  141.                CCCCSSSSRRRROOOOTTTT: Single precision.
  142.                ZZZZDDDDRRRROOOOTTTT: Double precision.
  143.  
  144. NNNNOOOOTTTTEEEESSSS
  145.      These routines are extensions to the Level 1 BLAS.
  146.  
  147.    DDDDaaaattttaaaa TTTTyyyyppppeeeessss
  148.      The following data types are described in this documentation:
  149.  
  150.           TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee
  151.  
  152.      Fortran:
  153.  
  154.           Array dimensioned _n           xxxx((((nnnn))))
  155.  
  156.           Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  157.  
  158.           Single precision              RRRREEEEAAAALLLL
  159.  
  160.           Double precision              DDDDOOOOUUUUBBBBLLLLEEEE PPPPRRRREEEECCCCIIIISSSSIIIIOOOONNNN
  161.  
  162.           Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  163.  
  164.           Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  165.  
  166.      C/C++:
  167.  
  168.           Array dimensioned _n           xxxx[[[[_n]]]]
  169.  
  170.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  171.  
  172.           Single precision              ffffllllooooaaaatttt
  173.  
  174.           Double precision              ddddoooouuuubbbblllleeee
  175.  
  176.           Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  177.  
  178.           Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  179.  
  180.      C++ STL:
  181.  
  182.           Array dimensioned _n           xxxx[[[[_n]]]]
  183.  
  184.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  185.  
  186.           Single precision              ffffllllooooaaaatttt
  187.  
  188.           Double precision              ddddoooouuuubbbblllleeee
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCSSSSRRRROOOOTTTT((((3333SSSS))))                                                            CCCCSSSSRRRROOOOTTTT((((3333SSSS))))
  203.  
  204.  
  205.  
  206.           Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  207.  
  208.           Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  209.  
  210. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  211.      IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS1111(3S), SSSSRRRROOOOTTTT(3S), SSSSRRRROOOOTTTTGGGG(3S), SSSSRRRROOOOTTTTMMMM(3S)
  212.  
  213.      IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
  214.      Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
  215.      Linear Algebra Subprograms Technical Forum.
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.                                                                         PPPPaaaaggggeeee 4444
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.